<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Noble Engine API reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
	<link rel="icon" href="favicon.ico">
</head>
<body>

<div id="container">

<div id="main">


<!-- Menu -->

<div id="navigation">
	<a href="../index.html"><div class="logo">
		<h1>Noble Engine</h1>
	</div></a>

		<div class="nav-module">
			<h2>Noble.Bonk</h2>
			<ul>
					<h3>Functions</h3>
					<ul>
							<li><a href="#Noble.Bonk.startCheckingDebugBonks">.startCheckingDebugBonks</a></li>
							<li><a href="#Noble.Bonk.stopCheckingDebugBonks">.stopCheckingDebugBonks</a></li>
							<li><a href="#Noble.Bonk.disableDebugBonkChecking">.disableDebugBonkChecking</a></li>
							<li><a href="#Noble.Bonk.checkingDebugBonks">.checkingDebugBonks</a></li>
							<li><a href="#Noble.Bonk.checkDebugBonks">.checkDebugBonks</a></li>
					</ul>
			</ul>
		</div>


	<div class="nav-modules">
			<div class="nav-kind">
					<h3>Modules</h3>
					<ul>
								<li><a href="../modules/Noble.html">Noble</a></li>
								<li><a href="../modules/Noble.Animation.html">Noble.Animation</a></li>
								<li><span class="selected">Noble.Bonk</span></li>
								<li><a href="../modules/Noble.GameData.html">Noble.GameData</a></li>
								<li><a href="../modules/Noble.Input.html">Noble.Input</a></li>
								<li><a href="../modules/Noble.Menu.html">Noble.Menu</a></li>
								<li><a href="../modules/Noble.Settings.html">Noble.Settings</a></li>
								<li><a href="../modules/Noble.Text.html">Noble.Text</a></li>
								<li><a href="../modules/Noble.Transition.html">Noble.Transition</a></li>
								<li><a href="../modules/Ease.html">Ease</a></li>
					</ul>
			</div>
			<div class="nav-kind">
					<h3>Classes</h3>
					<ul>
								<li><a href="../classes/NobleScene.html">NobleScene</a></li>
								<li><a href="../classes/NobleSprite.html">NobleSprite</a></li>
					</ul>
			</div>
			<div class="nav-kind">
					<h3>Examples</h3>
					<ul>
								<li><a href="../examples/SceneTemplate.lua.html">SceneTemplate.lua</a></li>
					</ul>
			</div>
	</div>

</div>

<div id="content">

		<h1>Noble.Bonk</h1>
		<p>Engine-specific error handling.</p>
		<p> Noble Engine overrides/supersedes some Playdate SDK behavior. A "bonk" is what happens when your game breaks the engine.</p>

<p> Most bonks will throw during normal operation, but others ("debug bonks") introduce some execution overhead so are not
 checked by default.</p>

		<hr/>

			<h2 class="section-header "><a name="Functions"></a>Functions</h2>
			<!--  -->
			<dl class="function">
					<dt>
						<a name = "Noble.Bonk.startCheckingDebugBonks"></a>
						<span class="item-name">Noble.Bonk.startCheckingDebugBonks()<span>
					</dt>
					<dd>
						Begin checking for debug bonks, <strong>on every frame</strong>.  This introduces needless overhead, so don't do it in a release build.
 You can only run this if you ran previously <code>Noble.new()</code> with <code>__enableDebugBonkChecking</code> as true, which you should also not do in a release build.




							<h3>See</h3>
							<ul>
									<a href="../modules/Noble.html#new">Noble.new</a>
							</ul>


					</dd>
					<dt>
						<a name = "Noble.Bonk.stopCheckingDebugBonks"></a>
						<span class="item-name">Noble.Bonk.stopCheckingDebugBonks()<span>
					</dt>
					<dd>
						Stop checking for debug bonks on every frame. </p>

<p> <strong>NOTE: You can only run this if debug bonk checking is enabled.</strong>






					</dd>
					<dt>
						<a name = "Noble.Bonk.disableDebugBonkChecking"></a>
						<span class="item-name">Noble.Bonk.disableDebugBonkChecking()<span>
					</dt>
					<dd>
						Disable the ability to check for debug bonks.  It frees up some memory. Once you disable debug bonk checking, you cannot re-enable it.</p>

<p> <strong>NOTE: You can only run this if debug bonk checking is enabled.</strong>






					</dd>
					<dt>
						<a name = "Noble.Bonk.checkingDebugBonks"></a>
						<span class="item-name">Noble.Bonk.checkingDebugBonks()<span>
					</dt>
					<dd>
						Are we debug bonk checking for debug bonks?


							<h3>Returns</h3>
								<ol>

											<span class="types"><span class="type">bool</span></span>



								</ol>




					</dd>
					<dt>
						<a name = "Noble.Bonk.checkDebugBonks"></a>
						<span class="item-name">Noble.Bonk.checkDebugBonks()<span>
					</dt>
					<dd>
						Manually check for debug bonks.
 This method runs every frame when <a href="../modules/Noble.Bonk.html#Noble.Bonk.checkingDebugBonks">checkingDebugBonks</a> is true, but you may call it manually instead.</p>

<p> <strong>NOTE: You can only run this if debug bonk checking is enabled.</strong>






					</dd>
			</dl>


</div> <!-- id="content" -->

</div> <!-- id="main" -->

<div id="about">
	<span><a href="https://github.com/NobleRobot/NobleEngine">Noble Engine</a> by Mark LaCroix, <a href="https://noblerobot.com">Noble Robot</a></span>
	<span style="float:right;">
		Documentation created using <a href="https://github.com/stevedonovan/LDoc">LDoc 1.5.0</a>.
	</span>
</div> <!-- id="about" -->

</div> <!-- id="container" -->

</body>
</html>

